bgp

---

routing/bgp

Conditions: !smips
Type: Directory

Argument	Type	Description
routing-table ( unset )	enum	Name of the routing table, to install routes in. Overrides the instance parameter.
vrf ( unset )	enum	Name of the VRF BGP connections operates on. By default uses the "main" routing table.
templates ( unset )	multi_arg { enum }	List of template names that will be used to inherit parameter values from. Useful feature, to easily configure groups with overlapping configuration options.
as ( unset )	as_arg	A 32-bit BGP autonomous system number. The value accepts AS-Plain or AS-Dot formats. Override the instance ASN and configure BGP confederation using the following format: confederation_as/as. For example, if your AS is 34 and your confederation AS is 43, set as=43/34.
nexthop-choice ( unset )	enum (default | force-self | propagate)	Affect outgoing NEXT_HOP attribute selection. Next-hops set in filters always take precedence and are not changed on route reflection except when set in a filter. default - select the next-hop as described in RFC 4271 force-self - use the local address of the interface that connects to the peer as the next-hop propagate - propagate received next-hop; if the route has a BGP NEXT_HOP attribute, use it as the next-hop; otherwise, fall back to the default case
multihop ( unset )	bool	Enable when the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for eBGP only, excluding iBGP peers local to the confederation). It also affects: Whether to accept connections from peers not in the same network (the remote address of the connection is used for this check) Whether to accept incoming routes with a NEXT_HOP attribute not in the same network as the address used to establish the connection The target scope of routes installed from this peer; routes from multi-hop or iBGP peers resolve their next-hops through IGP routes by default
hold-time ( unset )	alt { enum (infinity) { infinity:0 } , time [3 .. 65535] }	Specifies the BGP Hold Time value to be used when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be used (note that the special value 0 or 'infinity' is lower than any other value) * infinity - never expire the connection and never send keepalive messages.
keepalive-time ( unset )	time	The interval between keepalive messages, if not set then by default keepalive is 1/3 of the hold-time.
afi ( unset )	ubit (ip, ipv6, l2vpn, l2vpn-cisco, vpnv4, vpnv6, evpn)	List of address families this peer can exchange routing information. The remote peer must support BGP capabilities optional parameter (they usually do) to negotiate any other address families than IP.
cisco-vpls-nlri-len-fmt ( unset )	enum (auto-bits | auto-bytes | bits | bytes)	VPLS NLRI length format type. Used for compatibility with Cisco VPLS. [[Read more>>]].
output.remove-private-as ( unset )	bool	If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
output.as-override ( unset )	bool	If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepend.
use-bfd ( unset )	bool	Whether to use the BFD protocol for faster connection state detection.
save-to ( unset )	string	Filename to save BGP protocol-specific packet content (Exported PDU) into pcap format. This method allows much simpler peer-specific packet capturing for debugging purposes.
output.add-path ( unset )	ubit (ip, ipv6)	Enable sending of additional paths for specified address families (BGP Addpath).
output.affinity ( unset )	enum (main | alone | remote-as | instance | afi | vrf | input)	Configure output multicore processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session is processed in its own process, the most likely best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multicore devices with small amount of cores) input - run output in the same process as input (can be set only for output affinity)
output.redistribute ( unset )	ubit (connected, static, rip, ospf, isis, bgp, vpn, dhcp, fantasy, modem, bgp-mpls-vpn, slaac)	Enable redistribution of specified route types.
output.filter-select ( unset )	enum	Name of the routing select chain to be used for prefix selection. If not specified, then default selection is used.
output.filter-chain ( unset )	enum	Name of the routing filter chain to be used on the output prefixes. If the chain is not specified, then BGP by default accepts everything.
output.network ( unset )	enum	Name of the address list used to send local networks. The network is sent only if a matching IGP route exists in the routing table and its ORIGIN attribute is set to IGP, other distribution methods have ORIGIN attribute set to INCOMPLETE.
output.network-blackhole ( unset )	bool
output.default-originate ( unset )	enum (never | if-installed | always)	Specifies default route (0.0.0.0/0) distribution method. 'if-installed' option can be used to distribute default route only if corresponding IGP route present in the routing table.
output.default-prepend ( unset )	num	How many times to prepend local ASN.
output.no-client-to-client-reflection ( unset )	bool	Disable client-to-client route reflection in Route Reflector setups.
output.no-early-cut ( unset )	bool	The early cut is the mechanism, to guess (based on default RFC behavior) what would happen with the sent NPLRI when received by the remote peer. If the algorithm determines that the NLRI is going to be dropped, a peer will not even try to send it. However such behavior may not be desired in specific scenarios, then this option should be used to disable the early cut feature. Early cut works with eBGP sessions.
output.keep-sent-attributes ( unset )	bool	Store in memory sent prefix attributes, required for dump-saved-advertisements command to work. By default, sent-out prefixes are not stored to preserve the router's memory. An option should be enabled only for debugging purposes when necessary to see currently advertised prefixes.
input.add-path ( unset )	ubit (ip, ipv6)	Accept received additional paths (BGP Addpath) for specified address families.
input.attr-error-handling	enum (default | revised)
input.affinity ( unset )	enum (main | alone | remote-as | instance | afi | vrf)	Configure input multi-core processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session are processed in its own process, most likely the best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multi-core devices with a small amount of cores) input - run output in the same process as input (can be set only for output affinity)
input.filter ( unset )	enum	Name of the routing filter chain to be used on input prefixes. This happens after NLRIs are processed. If the chain is not specified, then BGP by default accepts everything.
input.filter-nlri ( unset )	enum	Name of the filter chain that will filter incoming IPv4/IPv6 NLRIs directly before they are  stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session restart.
input.allow-as ( unset )	num	Indicates how many times to allow your own AS number in AS-PATH, before discarding a prefix.
input.accept-nlri ( unset )	enum	Name of the ipv4/6 address-list. A quick way to filter incoming updates with specific NLRIs. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session restart.
input.filter-communities ( unset )	enum	A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.filter-ext-communities ( unset )	enum	A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.filter-large-communities ( unset )	enum	A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.accept-communities ( unset )	enum	A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.accept-ext-communities ( unset )	enum	A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.accept-large-communities ( unset )	enum	A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.filter-unknown ( unset )	enum	A quick way to filter incoming updates with specific "unknown" attributes. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.limit-process-routes-ipv4 ( unset )	enum (10 | 100 | 1000 | 10000 | 100000 | 1000000 | 10000000)	Try to limit the amount of received IPv4 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session "clear" command must be used to reset the flag if the limit is reached.
input.limit-process-routes-ipv6 ( unset )	enum (10 | 100 | 1000 | 10000 | 100000 | 1000000 | 10000000)	Try to limit the amount of received IPv6 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session "clear" command must be used to reset the flag if the limit is reached.

routing/bgp/template

Conditions: !smips
Type: Directory

Flag	Name	Description
*	default	default
X	disabled	disabled
I	inactive	inactive

Argument	Type	Description
name ( mandatory )	string
routing-table ( unset )	enum	Name of the routing table, to install routes in. Overrides the instance parameter.
vrf ( unset )	enum	Name of the VRF BGP connections operates on. By default uses the "main" routing table.
templates ( unset )	multi_arg { enum }	List of template names that will be used to inherit parameter values from. Useful feature, to easily configure groups with overlapping configuration options.
as ( unset )	as_arg	A 32-bit BGP autonomous system number. The value accepts AS-Plain or AS-Dot formats. Override the instance ASN and configure BGP confederation using the following format: confederation_as/as. For example, if your AS is 34 and your confederation AS is 43, set as=43/34.
nexthop-choice ( unset )	enum (default | force-self | propagate)	Affect outgoing NEXT_HOP attribute selection. Next-hops set in filters always take precedence and are not changed on route reflection except when set in a filter. default - select the next-hop as described in RFC 4271 force-self - use the local address of the interface that connects to the peer as the next-hop propagate - propagate received next-hop; if the route has a BGP NEXT_HOP attribute, use it as the next-hop; otherwise, fall back to the default case
multihop ( unset )	bool	Enable when the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for eBGP only, excluding iBGP peers local to the confederation). It also affects: Whether to accept connections from peers not in the same network (the remote address of the connection is used for this check) Whether to accept incoming routes with a NEXT_HOP attribute not in the same network as the address used to establish the connection The target scope of routes installed from this peer; routes from multi-hop or iBGP peers resolve their next-hops through IGP routes by default
hold-time ( unset )	alt { enum (infinity) { infinity:0 } , time [3 .. 65535] }	Specifies the BGP Hold Time value to be used when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be used (note that the special value 0 or 'infinity' is lower than any other value) * infinity - never expire the connection and never send keepalive messages.
keepalive-time ( unset )	time	The interval between keepalive messages, if not set then by default keepalive is 1/3 of the hold-time.
afi ( unset )	ubit (ip, ipv6, l2vpn, l2vpn-cisco, vpnv4, vpnv6, evpn)	List of address families this peer can exchange routing information. The remote peer must support BGP capabilities optional parameter (they usually do) to negotiate any other address families than IP.
cisco-vpls-nlri-len-fmt ( unset )	enum (auto-bits | auto-bytes | bits | bytes)	VPLS NLRI length format type. Used for compatibility with Cisco VPLS. [[Read more>>]].
output.remove-private-as ( unset )	bool	If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
output.as-override ( unset )	bool	If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepend.
use-bfd ( unset )	bool	Whether to use the BFD protocol for faster connection state detection.
save-to ( unset )	string	Filename to save BGP protocol-specific packet content (Exported PDU) into pcap format. This method allows much simpler peer-specific packet capturing for debugging purposes.
output.add-path ( unset )	ubit (ip, ipv6)	Enable sending of additional paths for specified address families (BGP Addpath).
output.affinity ( unset )	enum (main | alone | remote-as | instance | afi | vrf | input)	Configure output multicore processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session is processed in its own process, the most likely best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multicore devices with small amount of cores) input - run output in the same process as input (can be set only for output affinity)
output.redistribute ( unset )	ubit (connected, static, rip, ospf, isis, bgp, vpn, dhcp, fantasy, modem, bgp-mpls-vpn, slaac)	Enable redistribution of specified route types.
output.filter-select ( unset )	enum	Name of the routing select chain to be used for prefix selection. If not specified, then default selection is used.
output.filter-chain ( unset )	enum	Name of the routing filter chain to be used on the output prefixes. If the chain is not specified, then BGP by default accepts everything.
output.network ( unset )	enum	Name of the address list used to send local networks. The network is sent only if a matching IGP route exists in the routing table and its ORIGIN attribute is set to IGP, other distribution methods have ORIGIN attribute set to INCOMPLETE.
output.network-blackhole ( unset )	bool
output.default-originate ( unset )	enum (never | if-installed | always)	Specifies default route (0.0.0.0/0) distribution method. 'if-installed' option can be used to distribute default route only if corresponding IGP route present in the routing table.
output.default-prepend ( unset )	num	How many times to prepend local ASN.
output.no-client-to-client-reflection ( unset )	bool	Disable client-to-client route reflection in Route Reflector setups.
output.no-early-cut ( unset )	bool	The early cut is the mechanism, to guess (based on default RFC behavior) what would happen with the sent NPLRI when received by the remote peer. If the algorithm determines that the NLRI is going to be dropped, a peer will not even try to send it. However such behavior may not be desired in specific scenarios, then this option should be used to disable the early cut feature. Early cut works with eBGP sessions.
output.keep-sent-attributes ( unset )	bool	Store in memory sent prefix attributes, required for dump-saved-advertisements command to work. By default, sent-out prefixes are not stored to preserve the router's memory. An option should be enabled only for debugging purposes when necessary to see currently advertised prefixes.
input.add-path ( unset )	ubit (ip, ipv6)	Accept received additional paths (BGP Addpath) for specified address families.
input.attr-error-handling	enum (default | revised)
input.affinity ( unset )	enum (main | alone | remote-as | instance | afi | vrf)	Configure input multi-core processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session are processed in its own process, most likely the best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multi-core devices with a small amount of cores) input - run output in the same process as input (can be set only for output affinity)
input.filter ( unset )	enum	Name of the routing filter chain to be used on input prefixes. This happens after NLRIs are processed. If the chain is not specified, then BGP by default accepts everything.
input.filter-nlri ( unset )	enum	Name of the filter chain that will filter incoming IPv4/IPv6 NLRIs directly before they are  stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session restart.
input.allow-as ( unset )	num	Indicates how many times to allow your own AS number in AS-PATH, before discarding a prefix.
input.accept-nlri ( unset )	enum	Name of the ipv4/6 address-list. A quick way to filter incoming updates with specific NLRIs. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session restart.
input.filter-communities ( unset )	enum	A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.filter-ext-communities ( unset )	enum	A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.filter-large-communities ( unset )	enum	A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.accept-communities ( unset )	enum	A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.accept-ext-communities ( unset )	enum	A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.accept-large-communities ( unset )	enum	A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.filter-unknown ( unset )	enum	A quick way to filter incoming updates with specific "unknown" attributes. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.limit-process-routes-ipv4 ( unset )	enum (10 | 100 | 1000 | 10000 | 100000 | 1000000 | 10000000)	Try to limit the amount of received IPv4 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session "clear" command must be used to reset the flag if the limit is reached.
input.limit-process-routes-ipv6 ( unset )	enum (10 | 100 | 1000 | 10000 | 100000 | 1000000 | 10000000)	Try to limit the amount of received IPv6 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session "clear" command must be used to reset the flag if the limit is reached.

routing/bgp/instance

Conditions: !smips
Type: Directory

Flag	Name	Description
X	disabled	disabled
I	inactive	inactive

Argument	Type	Description
name	string
routing-table ( unset )	enum	Name of the routing table, to install routes in.
vrf ( unset )	enum	Name of the VRF BGP connections operates on. By default always use the "main" routing table.
router-id ( unset )	alt { ipAddr , enum }	BGP Router ID to be used. Use the ID from the /routing/router-id configuration by specifying the reference name, or set the ID directly by specifying IP. Equal router-ids are also used to group peers into one instance.
as ( unset )	super { as_arg , [ /as_arg] }	32-bit BGP autonomous system number. Enter the value in AS-Plain or AS-Dot formats. Configure BGP confederation using the following format: confederation_as/as. For example, if your AS is 34 and your confederation AS is 43, set as=43/34.
cluster-id ( unset )	ipAddr	For route reflector instances, specify the cluster ID of the route reflector cluster. This attribute identifies routing updates from other route reflectors in the cluster to avoid routing information loops. Typically, only one route reflector exists per cluster; in this case, do not configure 'cluster-id' and BGP router ID is used instead.
ignore-as-path-len ( unset )	bool	Ignore the AS_PATH attribute in the BGP route selection algorithm. Applies to input.
multipath ( unset )	num	Install the specified number of ECMP routes received by add-path or selected by best path selection.

routing/bgp/connection

Conditions: !smips
Type: Directory

A list of all connection-specific parameters can be seen in the table below.

In addition to connection-specific parameters, template-specific parameters are also directly exposed in this menu, for easier configuration in simple scenarios (when templates are not necessary).

Flag	Name	Description
D	dynamic	dynamic
X	disabled	disabled
I	inactive	inactive

Argument	Type	Description
name ( mandatory )	string
instance ( mandatory )	enum
remote.address ( unset )	address (flags=46i/+:)	Remote address used to connect and/or listen to.
remote.port ( unset )	num
remote.as ( unset )	super { as_arg , [ /as_arg] }	Remote AS number. If not specified BGP will determine remote AS automatically from the OPEN message.
remote.ttl	num	Acceptable minimum Time To Live, the hop limit for this TCP connection. For example, if 'ttl=255' then only single-hop neighbors will be able to establish the connection. This property only affects EBGP peers.
remote.allowed-as ( unset )	enum	Name of the num-list containing remote AS numbers that will be allowed to connect. Useful for dynamic peer configuration.
local.address ( unset )	address (flags=46i:)
local.port ( unset )	num
local.ttl	num	Time To Live (hop limit) that will be recorded in sent TCP packets.
local.role ( mandatory )	enum (ibgp | ibgp-rr | ebgp | ebgp-provider | ebgp-rs | ebgp-rs-client | ebgp-customer | ebgp-peer)	BGP role. In most scenarios, set to iBGP or eBGP. For more information on BGP roles, see the corresponding RFC 9234.
tcp-md5-key ( unset )	string	Key used to authenticate the connection with TCP MD5 signature as described in RFC 2385. Leave empty to disable authentication.
connect	bool	Whether to allow the router to initiate the connection.
listen	bool	Enable listening for incoming connections. If remote.address is a host address and listening is enabled, close the listening socket after the first successful accept. If remote.address is a subnet and listening is enabled, the listening socket remains open after the first successful accept with a hard-coded limit of 256 open connections.
routing-table ( unset )	enum	Name of the routing table, to install routes in. Overrides the instance parameter.
vrf ( unset )	enum	Name of the VRF BGP connections operates on. By default uses the "main" routing table.
templates ( unset )	multi_arg { enum }	List of template names that will be used to inherit parameter values from. Useful feature, to easily configure groups with overlapping configuration options.
as ( unset )	as_arg	A 32-bit BGP autonomous system number. The value accepts AS-Plain or AS-Dot formats. Override the instance ASN and configure BGP confederation using the following format: confederation_as/as. For example, if your AS is 34 and your confederation AS is 43, set as=43/34.
nexthop-choice ( unset )	enum (default | force-self | propagate)	Affect outgoing NEXT_HOP attribute selection. Next-hops set in filters always take precedence and are not changed on route reflection except when set in a filter. default - select the next-hop as described in RFC 4271 force-self - use the local address of the interface that connects to the peer as the next-hop propagate - propagate received next-hop; if the route has a BGP NEXT_HOP attribute, use it as the next-hop; otherwise, fall back to the default case
multihop ( unset )	bool	Enable when the remote peer is more than one hop away. This option affects outgoing next-hop selection as described in RFC 4271 (for eBGP only, excluding iBGP peers local to the confederation). It also affects: Whether to accept connections from peers not in the same network (the remote address of the connection is used for this check) Whether to accept incoming routes with a NEXT_HOP attribute not in the same network as the address used to establish the connection The target scope of routes installed from this peer; routes from multi-hop or iBGP peers resolve their next-hops through IGP routes by default
hold-time ( unset )	alt { enum (infinity) { infinity:0 } , time [3 .. 65535] }	Specifies the BGP Hold Time value to be used when negotiating with peers. According to the BGP specification, if the router does not receive successive KEEPALIVE and/or UPDATE and/or NOTIFICATION messages within the period specified in the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed. The minimal hold-time value of both peers will be used (note that the special value 0 or 'infinity' is lower than any other value) * infinity - never expire the connection and never send keepalive messages.
keepalive-time ( unset )	time	The interval between keepalive messages, if not set then by default keepalive is 1/3 of the hold-time.
afi ( unset )	ubit (ip, ipv6, l2vpn, l2vpn-cisco, vpnv4, vpnv6, evpn)	List of address families this peer can exchange routing information. The remote peer must support BGP capabilities optional parameter (they usually do) to negotiate any other address families than IP.
cisco-vpls-nlri-len-fmt ( unset )	enum (auto-bits | auto-bytes | bits | bytes)	VPLS NLRI length format type. Used for compatibility with Cisco VPLS. [[Read more>>]].
output.remove-private-as ( unset )	bool	If set, then the BGP AS-PATH attribute is removed before sending out route updates if the attribute contains only private AS numbers. The removal process happens before routing filters are applied and before the local, AS number is prepended to the AS path.
output.as-override ( unset )	bool	If set, then all instances of the remote peer's AS number in the BGP AS-PATH attribute are replaced with the local AS number before sending a route update to that peer. Happens before routing filters and prepend.
use-bfd ( unset )	bool	Whether to use the BFD protocol for faster connection state detection.
save-to ( unset )	string	Filename to save BGP protocol-specific packet content (Exported PDU) into pcap format. This method allows much simpler peer-specific packet capturing for debugging purposes.
output.add-path ( unset )	ubit (ip, ipv6)	Enable sending of additional paths for specified address families (BGP Addpath).
output.affinity ( unset )	enum (main | alone | remote-as | instance | afi | vrf | input)	Configure output multicore processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session is processed in its own process, the most likely best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multicore devices with small amount of cores) input - run output in the same process as input (can be set only for output affinity)
output.redistribute ( unset )	ubit (connected, static, rip, ospf, isis, bgp, vpn, dhcp, fantasy, modem, bgp-mpls-vpn, slaac)	Enable redistribution of specified route types.
output.filter-select ( unset )	enum	Name of the routing select chain to be used for prefix selection. If not specified, then default selection is used.
output.filter-chain ( unset )	enum	Name of the routing filter chain to be used on the output prefixes. If the chain is not specified, then BGP by default accepts everything.
output.network ( unset )	enum	Name of the address list used to send local networks. The network is sent only if a matching IGP route exists in the routing table and its ORIGIN attribute is set to IGP, other distribution methods have ORIGIN attribute set to INCOMPLETE.
output.network-blackhole ( unset )	bool
output.default-originate ( unset )	enum (never | if-installed | always)	Specifies default route (0.0.0.0/0) distribution method. 'if-installed' option can be used to distribute default route only if corresponding IGP route present in the routing table.
output.default-prepend ( unset )	num	How many times to prepend local ASN.
output.no-client-to-client-reflection ( unset )	bool	Disable client-to-client route reflection in Route Reflector setups.
output.no-early-cut ( unset )	bool	The early cut is the mechanism, to guess (based on default RFC behavior) what would happen with the sent NPLRI when received by the remote peer. If the algorithm determines that the NLRI is going to be dropped, a peer will not even try to send it. However such behavior may not be desired in specific scenarios, then this option should be used to disable the early cut feature. Early cut works with eBGP sessions.
output.keep-sent-attributes ( unset )	bool	Store in memory sent prefix attributes, required for dump-saved-advertisements command to work. By default, sent-out prefixes are not stored to preserve the router's memory. An option should be enabled only for debugging purposes when necessary to see currently advertised prefixes.
input.add-path ( unset )	ubit (ip, ipv6)	Accept received additional paths (BGP Addpath) for specified address families.
input.attr-error-handling	enum (default | revised)
input.affinity ( unset )	enum (main | alone | remote-as | instance | afi | vrf)	Configure input multi-core processing. Read more in Routing Protocol Multi-core Support article. alone - input and output of each session are processed in its own process, most likely the best option when there are a lot of cores and a lot of peers afi, instance, vrf, remote-as - try to run input/output of new session in process with similar parameters main - run input/output in the main process (could potentially increase performance on single-core even possibly on multi-core devices with a small amount of cores) input - run output in the same process as input (can be set only for output affinity)
input.filter ( unset )	enum	Name of the routing filter chain to be used on input prefixes. This happens after NLRIs are processed. If the chain is not specified, then BGP by default accepts everything.
input.filter-nlri ( unset )	enum	Name of the filter chain that will filter incoming IPv4/IPv6 NLRIs directly before they are  stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session restart.
input.allow-as ( unset )	num	Indicates how many times to allow your own AS number in AS-PATH, before discarding a prefix.
input.accept-nlri ( unset )	enum	Name of the ipv4/6 address-list. A quick way to filter incoming updates with specific NLRIs. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session restart.
input.filter-communities ( unset )	enum	A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.filter-ext-communities ( unset )	enum	A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.filter-large-communities ( unset )	enum	A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.accept-communities ( unset )	enum	A quick way to filter incoming updates with specific communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.accept-ext-communities ( unset )	enum	A quick way to filter incoming updates with specific extended communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.accept-large-communities ( unset )	enum	A quick way to filter incoming updates with specific large communities. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.filter-unknown ( unset )	enum	A quick way to filter incoming updates with specific "unknown" attributes. It allows filtering incoming messages directly before they are even parsed and stored in memory, that way significantly reducing memory usage. Regular input filter chain can only reject prefixes which means that it will still eat memory and will be visible in /routing route table as "not active, filtered". Changes to be applied required session refresh.
input.limit-process-routes-ipv4 ( unset )	enum (10 | 100 | 1000 | 10000 | 100000 | 1000000 | 10000000)	Try to limit the amount of received IPv4 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session "clear" command must be used to reset the flag if the limit is reached.
input.limit-process-routes-ipv6 ( unset )	enum (10 | 100 | 1000 | 10000 | 100000 | 1000000 | 10000000)	Try to limit the amount of received IPv6 routes to the specified number. This number does not represent the exact number of routes going to be installed in the routing table by the peer. BGP session "clear" command must be used to reset the flag if the limit is reached.

Read-only Argument	Type	Description
local.default-address	address (flags=46i:)

routing/bgp/advertisements

Conditions: !smips
Type: Directory

Read-only Argument	Type	Description
peer	enum
dst	address (flags=46/R)
afi	enum (ip | ipv6 | l2vpn | l2vpn-cisco | vpnv4 | vpnv6)
local-pref	num
med	num
nexthop	multi_arg { address (flags=46) }
nlri	multi_arg { address (flags=46i/SR) }
withdrawn	multi_arg { address (flags=46i/SR) }
origin	num
as-path	multi_arg { string }
as4-path	multi_arg { string }
communities	multi_arg { string }
ext-communities	multi_arg { string }
large-communities	multi_arg { string }
atomic-aggregate	bool
aggregator	string
as4-aggregator	string
originator-id	ipAddr
cluster-list	multi_arg { ipAddr }
igp-metric	num
otc	num

routing/bgp/session

Conditions: !smips
Type: Directory

List of BGP already established, not yet connected or disconnected sessions.

Flag	Name	Description
E	established	established

Read-only Argument	Type	Description
name	string
instance	enum
remote.address	address (flags=46iv+:)
remote.port	num
remote.as	super { as_arg , [ /as_arg] }
remote.id	ipAddr
remote.refused-cap-opt	bool
remote.capabilities	ubit (mp, rr, orf, enhe, em, sec, ml, role, gr, as4, dyn, ms, ap, err, llgr, fqdn)	Remote peer's advertised/supported capabilities.
remote.afi	ubit (ip, ipv6, l2vpn, l2vpn-cisco, vpnv4, vpnv6, evpn)	Remote peer's advertised/supported address families.
remote.hold-time	alt { enum (infinity) { infinity:0 } , time [3 .. 65535] }
remote.messages	num	Number of BGP messages received from remote peer.
remote.bytes	num	Total number of bytes received from remote peer.
remote.gr-restart	bool
remote.gr-time	num
remote.gr-afi	ubit (ip, ipv6, l2vpn, l2vpn-cisco, vpnv4, vpnv6)
remote.gr-afi-fwp	ubit (ip, ipv6, l2vpn, l2vpn-cisco, vpnv4, vpnv6)
remote.eor	ubit (ip, ipv6, l2vpn, l2vpn-cisco, vpnv4, vpnv6, evpn)	List of address families that received end-of-rib from remote peer.
remote.role	enum (provider | route-server | route-server-client | customer | peer)
local.role	enum (ibgp | ibgp-rr | ebgp | ebgp-provider | ebgp-rs | ebgp-rs-client | ebgp-customer | ebgp-peer)
local.address	address (flags=46iv:)
local.port	num
local.as	super { as_arg , [ /as_arg] }
local.id	ipAddr
local.cluster-id	ipAddr
local.capabilities	ubit (mp, rr, enhe, role, gr, as4, ap)
local.afi	ubit (ip, ipv6, l2vpn, l2vpn-cisco, vpnv4, vpnv6, evpn)
local.messages	num
local.bytes	num
local.eor	ubit (ip, ipv6, l2vpn, l2vpn-cisco, vpnv4)
output.affinity	enum (main | alone | remote-as | instance | afi | vrf | input)
output.procid	num
output.filter-select	enum
output.filter-chain	enum
output.network	enum
output.add-path	ubit (ip, ipv6)
output.remove-private-as	bool
output.default-originate	enum (never | if-installed | always)
output.default-prepend	num
output.no-client-to-client-reflection	bool
output.no-early-cut	bool
output.keep-sent-attributes	bool
output.last-notification	string	Content of last sent notification message.
input.affinity	enum (main | alone | remote-as | instance | afi | vrf)
input.procid	num	Shows which routing process the session is tied to.
input.filter	enum
input.allow-as	num
input.as-override	bool
input.ignore-as-path-len	bool
input.limit-process-routes	num
input.add-path	ubit (ip, ipv6)
input.last-notification	string	Content of last received notificatin message.
vrf	enum
ibgp	switch	Indicates if the session is iBGP.
ebgp	switch	Indicates if the session is eBGP.
limit-exceeded	switch	Indicates if received prefix count exceeds configured prefix limit by input.limit-process-routes-ipv4 and/or input.limit-process-routes-ipv6.
stopped	switch	Indicates whether session is administratively stopped.
routing-table	enum
nexthop-choice	enum (default | force-self | propagate)
cisco-vpls-nlri-len-fmt	enum (auto-bits | auto-bytes | bits | bytes)
multihop	bool
hold-time	alt { enum (infinity) { infinity:0 } , time [3 .. 65535] }
keepalive-time	time
use-bfd	bool
uptime	time	Uptime of established session.
last-started	date_arg
last-stopped	date_arg
save-to	string
prefix-count	num
keepalive-timer	time
restart-timer	time

routing/bgp/session/resend

Conditions: !smips
Type: Command

Resend prefixes to a specified BGP session. The command takes two arguments:

Argument	Type	Description
afi	enum (ip | ipv6 | l2vpn | vpnv4)	Specifies for which address families to resend prefixes.
save-to	string	The name of the pcap file where to dump resent messages, can be used for debugging purposes.

routing/bgp/session/refresh

Conditions: !smips
Type: Command

Send route refresh to a specified BGP session. Is used to trigger re-sending all the routes from the remote peer.

Argument	Type	Description
afi	enum (ip | ipv6 | l2vpn | vpnv4)	Specifies for which address family to send route refresh.

routing/bgp/session/stop

Conditions: !smips
Type: Command

routing/bgp/session/dump-saved-advertisements

Conditions: !smips
Type: Command

Dump saved advertisements from specified BGP session in the *.pcap file.

Argument	Type	Description
save-to	string	The filename where to store the PCAP data.

routing/bgp/session/clear

Conditions: !smips
Type: Command

Clear the session flags. For example, to be able to re-establish a session after the prefix limit is reached "limit-exceeded" flag must be cleared. It can be done by specifying flag parameter, which is able to take the following values:

• input-last-notification  
• limit-exceeded  
• output-last-notification  
• refused-cap-opt  
• stopped

Argument	Type	Description
flag	enum (refused-cap-opt | stopped | limit-exceeded | input-last-notification | output-last-notification)	A flag to be cleared from BGP session.

routing/bgp/vpn

Conditions: !smips
Type: Directory

L3VPN VPNv4/VPNv6 instance configuration

Flag	Name	Description
X	disabled	disabled
I	inactive	inactive

Argument	Type	Description
name ( unset )	string
instance ( mandatory )	enum	Name of the instance this VPN is assigned to.
route-distinguisher ( mandatory )	string	Specifies the value that gets attached to route so that receiving routers can distinguish advertisements that may otherwise look the same. Used to distinguish between tenants using overlapping IP ranges. Also can be used to simplify convergence and redundancy within Virtual Network. RDs form MLAG pairs should be unique, too.
vrf ( mandatory )	enum	Name of the VRF table that this VPN instance will use.
label-allocation-policy ( mandatory )	enum (per-vrf | per-prefix)
import.route-targets ( unset )	obj_arg { address (flags=R) }	List of route targets that will be used to import VPNv4 routes. The accepted RT format is similar to the one for Route Distinguishers.
export.route-targets ( unset )	obj_arg { address (flags=R) }	List of route targets added when exporting VPNv4 routes. The accepted RT format is similar to the one for Route Distinguishers.
import.filter-chain ( unset )	enum
export.filter-select ( unset )	enum	The name of the routing/filter/select-chain that is used to select prefixes to be exported exporting.
export.filter-chain ( unset )	enum	The name of the routing/filter/chain that is used to filter prefixes before exporting.
export.redistribute ( unset )	ubit (connected, static, rip, ospf, isis, bgp, vpn, dhcp, fantasy, modem, slaac)	Enable redistribution of specified route types from a VRF to VPNv4.

routing/bgp/evpn

Conditions: !smips
Type: Directory

See EVPN documentation.

Flag	Name	Description
X	disabled	disabled

Argument	Type	Description
name ( unset )	string
instance ( mandatory )	enum	BGP instance this EVPN is assigned to.
vrf ( unset )	enum	Name of the VRF table that this EVPN instance will use.
rd ( unset )	address (flags=R)	Specifies the value that gets attached to route so that receiving routers can distinguish advertisements that may otherwise look the same. Used to distinguish between tenants using overlapping IP ranges. Also can be used to simplify convergence and redundancy within Virtual Network. RDs form MLAG pairs should be unique, too.
vni ( unset )	obj_arg { range_arg }	Range of Virtual Network Identifiers.
import.route-targets ( unset )	obj_arg { address (flags=R) }	List of route targets that will be used to import EVPN routes.
export.route-targets ( unset )	obj_arg { address (flags=R) }	List of route targets that will be added to EVPN routes when exporting.

routing/bgp/vpls

Conditions: !smips
Type: Directory

This menu lists all the configured BGP-based VPLS instances. These instances allow the router to advertise VPLS BGP NLRI and indicate that the router belongs to a specific customer VPLS network.

MP-BGP-based autodiscovery and signaling (RFC 4761).

Cisco VPLS BGP-based auto-discovery (draft-ietf-l2vpn-signaling-08).

Support for multiple import/export route target extended communities for BGP-based VPLS (both, RFC 4761 and draft-ietf-l2vpn-signaling-08).

Flag	Name	Description
X	disabled	disabled
I	inactive	inactive

TODO: pw-args graft is not imported

Argument	Type	Description
name ( unset )	string
vrf ( unset )	enum
rd ( unset )	address (flags=R)	Specifies the value that gets attached to VPLS NLRI so that receiving routers can distinguish advertisements that may otherwise look the same. This implies that a unique route-distinguisher for every VPLS must be used. It is not necessary to use the same route distinguisher for some VPLS on all routers forming that VPLS as distinguisher is not used for determining if some BGP NLRI is related to a particular VPLS (Route Target attribute is used for this), but it is mandatory to have different distinguishers for different VPLSes. Accepts 3 types of formats. Read more>>
site-id ( unset )	num	Unique site identifier. Each site must have a unique site-id. A parameter must be set for RFC 4761 style VPLS signaling.
cisco-id ( unset )	address	Unique identifier. A parameter must be set for cisco-style VPLS signaling. In most cases this should not be used, any modern software supports RFC 4761 style signaling (see site-id parameter). Parameter is a merge of l2-router-id and RD, for example: 10.155.155.1&6550:123
import-route-targets ( unset )	multi_arg { array-id, address (flags=R) }	The setting is used to determine if BGP NLRI is related to a particular VPLS, by comparing route targets received from BGP NLRI.
export-route-targets ( unset )	multi_arg { array-id, address (flags=R) }	he setting is used to tag BGP NLRI with one or more route targets which on the remote side is used by import-route-targets.
local-pref ( unset )	num
interface-list ( unset )	enum
pw-type ( unset )	enum (tagged-ethernet | raw-ethernet | vpls)	Pseudowire type. If not set then by default raw-ethernet i sused.
pw-l2mtu ( unset )	num	L2MTU value advertised to a remote peer.
pw-control-word ( unset )	enum (default | enabled | disabled)
bridge ( unset )	interface_enum
bridge-cost ( unset )	num	Cost of the bridge port.
bridge-horizon ( unset )	num	If set to none, bridge horizon will not be used.
bridge-pvid ( unset )	num	Used to assign port VLAN ID (pvid) for a dynamically bridged interface. This property only has an effect when bridge vlan-filtering is set to yes.

Read-only Argument	Type	Description
current-peers	string